Add support for request tracing via X-Request-ID header #5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ensures that `X-Request-ID` is defaulted to a random value, if no `X-Request-ID` is present in the request. * https://stackoverflow.com/questions/25433258/what-is-the-x-request-id-http-header * https://en.wikipedia.org/wiki/List_of_HTTP_header_fields * http://nginx.org/en/docs/http/ngx_http_core_module.html * https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#generate-request-id
hadrianvalentine
approved these changes
Feb 10, 2021
itskingori
commented
Feb 10, 2021
Comment on lines
1
to
+3
| log_format main '$remote_addr - $remote_user [$time_local] $status ' | ||
| '"$request" $body_bytes_sent "$http_referer" ' | ||
| '"$http_user_agent" "$http_x_forwarded_for"'; | ||
| '"$http_user_agent" "$http_x_forwarded_for" $proxy_x_request_id'; |
There was a problem hiding this comment.
I want to improve this log format to have a little more information but I think that's best done in another PR. Using the Kubernetes Ingress - Ingress log format as inspiration ...
log_format upstreaminfo
'$remote_addr - $remote_user [$time_local] "$request" '
'$status $body_bytes_sent "$http_referer" "$http_user_agent" '
'$request_length $request_time [$proxy_upstream_name] [$proxy_alternative_upstream_name] $upstream_addr '
'$upstream_response_length $upstream_response_time $upstream_status $req_id';
There was a problem hiding this comment.
I want to improve this log format to have a little more information but I think that's best done in another PR. Using the Kubernetes Ingress - Ingress log format as inspiration ...
Done in #6.
| proxy_set_header X-Forwarded-Proto $proxy_x_forwarded_proto; | ||
| proxy_set_header X-Forwarded-Ssl $proxy_x_forwarded_ssl; | ||
| proxy_set_header X-Forwarded-Port $proxy_x_forwarded_port; | ||
| proxy_set_header X-Request-ID $proxy_x_request_id; |
There was a problem hiding this comment.
Some apps like Rails with use this as the request_id if the X-Request-ID exists. Else, they generate one. So it's certainly useful to set it here because it will be used upstream. See ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If the
X-Request-IDis passed along, then it's easier to follow the chain of calls upstream. See commits for details. Each commit is an idea.